docs: replace release process document #3475
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The release process document that we have goes into some unnecessary detail, for example:
click the link in the console to go to your new branch in GitHub, then click *Create Pull Request*
)It's also out of date, with references to nix.
Further, it's missing some important parts, like where to update the portal docs and to remember to update the sdk submodule there.
Also, we no longer use a "driver" and a "validator," because the release process no longer involves running a bunch of nix commands manually.
This PR replaces release.adoc with release.md. My intention is to describe the current process at a high level, with enough detail to be able to execute the steps, while assuming that the reader knows how to use git and the GitHub UI. As we streamling the release process, I think this document will prove easier to update with the improved workflows.
How Has This Been Tested?
I ran markdownlint on it
Checklist: